.. highlightlang:: us

.. index:: @f{3dlegend}

.. _@f{3dlegend}:

@f{3dlegend}
============

.. us.tag  @f{3dlegend} NOTREADYENGLISH fieldfunction Changed5600

Creates a legend for 3D datasets.

.. function::  @f{3dlegend}
    @f{3dlegend(ssDiaName)}
    @f{3dlegend(ssDiaName, ssParameter)}
    @f{3dlegend(ssParameter)}

.. us.params

**Parameters**

.. uparam:: DiagramName

   *DiagramName* is the name of the diagram that contains the datasets.

.. uparam:: ssParameter

   A text from the following table. 

   .. list-table::
      :header-rows: 1

      * - Text
        - Description
      * - Standard
        - Line symbol with dataset info text
      * - ZName
        - Z channel name
      * - ZName.Unit
        - Z channel name with unit text
      * - Linesymbol.ZName.Unit
        - Line symbol with Z channel name with unit text
      * - Linesymbol.Filename.ZName.Unit
        - Line symbol with file name and Z channel name with unit text
      * - Linesymbol.ZAxisTitle
        - Line symbol with Z-axis title
      * - ZAxisTitle
        - Z-axis title

.. us.comment

**Comment**

The legend will be updated if the legend text or the dataset style is modified.

If the dataset legend text starts with an exclamation mark "!" the dataset will
not be displayed in the legend.

.. us.example

**Example**

``@f{3dlegend(standard)}``

A field function is always starting with characters "@f{" followed by the
field function name followed by a parameter list in round brackets followed 
by a closing curly bracket "}". The field result is enclosed curly brackets 
"{...}".

.. us.history

**History**

.. list-table::
   :header-rows: 1

   * - Version
     - Description
   * - R2014.0
     - New documentation.

.. seealso::
   :ref:`overview-field-functions`,
   :ref:`editupdate-fields`,
   :ref:`diagraminsert-field-function`

:sub:`id-1548101`